SetSysBeepVolume

SetSysBeepVolume
Header:	Sound.h		Carbon status:	Supported

Sets the current volume of the system alert sound.

OSErr SetSysBeepVolume (
    SInt32 level
);

Parameter descriptions

level: The desired volume level of the system alert sound.

function result: A result code.

DISCUSSION

With this function, you specify a volume with a 16-bit value, where 0 represents no volume (that is, silence) and 256 (hexadecimal $0100) represents full volume. The right and left volumes of a stereo sound are encoded as the high word and the low word, respectively, of a 32-bit value. Moreover, it’s possible to overdrive a particular volume level if you need to amplify a low signal. For example, the long word $02000200 specifies a volume level of twice full volume on both the left and right channels of a stereo sound.

Any calls to the SysBeep function use the volume set by the most recent call to SetSysBeepVolume.

SPECIAL CONSIDERATIONS

You can call this function at interrupt time.

VERSION NOTES

The SetSysBeepVolume function is available only in versions 3.0 and later of the Sound Manager.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.